home *** CD-ROM | disk | FTP | other *** search
/ The X-Philes (2nd Revision) / The X-Philes Number 1 (1995).iso / xphiles / hp48hor2 / cal.doc < prev    next >
Text File  |  1995-03-31  |  6KB  |  124 lines
  1. ***************************************************************************** 
  2. *         DOCUMENTATION FILE FOR HP48SX CALENDAR DRAWING FUNCTIONS          * 
  3. *                              Version 1.03                                 * 
  4. *                                                                           * 
  5. *                    by Kevin Jessup  August 30, 1991                       * 
  6. ***************************************************************************** 
  7.  
  8. [Note: Version 1.02 was on Goodies Disk #2.  -jkh-] 
  9.  
  10. Version 1.03 differs from 1.02 in the following ways... 
  11.  
  12.        - The calendar box is stored as a graphic object (GROB) rather 
  13.          than generated by a program.  This makes the total package 
  14.          500 bytes larger but execution speed is faster. 
  15.  
  16.        - Days that have any alarms due are now shown with the numerals in 
  17.          reverse video rather than with a BOX character after them. 
  18.  
  19. The remainder of this documentation has been taken from version 1.02 with 
  20. changes made as required. 
  21.  
  22. If you have successfully loaded the binary CALENDAR directory file, a 
  23. directory named CALENDAR should now be in your current working directory. 
  24. Place 'CALENDAR' on the stack, execute the BYTES command and verify the 
  25. following... 
  26.  
  27.    Checksum (on level 2):      # D6D2 (hex) or # 54994 (decimal) 
  28.    Byte count (on level 1):    3091 
  29.  
  30.    Note:       The checksum will change if the day, month or year global 
  31.                variables have been modified since you downloaded the 
  32.                directory! 
  33.  
  34.  
  35. Introduction 
  36. ------------ 
  37. These routines will display a calendar graphic for a specific year and month 
  38. on the 48SX display.  Functions are provided to move the calendar forward 
  39. or backwards in month or year increments.  Day of week and leap-year func- 
  40. tions are also provided. 
  41.  
  42. The CALENDAR directory should contain the following objects in the order 
  43. they appear below.  For ease of use, DO NOT re-order the directory. 
  44. Objects preceeded with an asterisk (*) are described in detail later.  All 
  45. other objects are subroutines used by the main functions and are NOT 
  46. described. 
  47.  
  48. Name       Object type     Purpose 
  49. -------    -----------     -------------------------------------------------- 
  50. * CURR     program         Draws a calendar for the current month. 
  51. * <-Y      program         Draws a calendar for the previous year, same month. 
  52. * Y->      program         Draws a calendar for the next year, same month. 
  53. * <-M      program         Draws a calendar for the previous month, same year. 
  54. * M->      program         Draws a calendar for the next month, same year. 
  55. * PCAL     program         Prints the last calendar dislayed. 
  56. * CAL      program         Given specific month and year, draws the calendar. 
  57. * DOW      program         Returns current day of week string to stack. 
  58. * SDOW     program         Given a date, returns day of week string to stack. 
  59. * RDOW     program         Given a date, returns day of week number to stack. 
  60. * LPYR     program         Given a year, determines if it is a leap year. 
  61. * ALMDATE? program         Given a date, determines if any alarms are due. 
  62.   MOY      list            Months of the year. 
  63.   DIM      list            Number of days in the months. 
  64.   DOWL     list            Days of the week. 
  65.   GENC     program         Main calendar graphic generating function. 
  66.   FILLD    program         Adds days and alarm flags to the calendar graphic. 
  67.   CPSDT    program         Compress date and time. 
  68.   EXPDT    program         Expand date and time. 
  69.   JFIX     program         Adjust for date mode. 
  70.   day      real number 
  71.   year     real number 
  72.   month    real number 
  73.   PPAR     list            Plot parameters. 
  74.   CALGROB  grob            Graphics object of the calendar "frame". 
  75.  
  76.  
  77. Detailed function descriptions 
  78. ------------------------------ 
  79.  
  80. CURR   Draws a calendar for the current month.  A graphic display of the 
  81.        month, year and appropriately positioned day numbers is generated. 
  82.        Days that have an alarm associated with them will contain a box 
  83.        to mark the alarm. 
  84.  
  85. <-Y    Same as CURR but backs up one year. 
  86.  
  87. Y->    Same as CURR but moves forward one year. 
  88.  
  89. <-M    Same as CURR but backs up one month. 
  90.  
  91. M->    Same as CURR but moves forward one month. 
  92.  
  93. PCAL   Prints the current contents of the PICT variable.  If some other 
  94.        program has not deleted PICT or modified it, the object printed 
  95.        should be the last calendar you displayed. 
  96.  
  97. CAL    Given a date on the stack in valid HP48SX date format (MM.DDYYYY or 
  98.        DD.MMYYYY) displays the calendar for the month as in CURR. 
  99.  
  100. DOW    Returns the current day of week text string to the stack. 
  101.  
  102. SDOW   Given a date as in CAL, returns the day of week text string to the 
  103.        stack. 
  104.  
  105. RDOW   Same as SDOW but returns a real number. 
  106.        Sunday = 0, Monday = 1,  ...  Saturday = 6. 
  107.  
  108. LPYR   Given a year on level 1, returns 1 if it is a leap year, else 0. 
  109.  
  110. ALMDATE? 
  111.        Given a date as in CAL, returns 1 if alarms are due on that date, 
  112.        else 0.  Always returns 0 if date input is less than the current 
  113.        date (Does not detect past-due alarms!). 
  114.  
  115.  
  116. Warranties and Support 
  117. ---------------------- 
  118. None provided.  Programs are supplied AS IS.  Use at your own risk. 
  119. This is freeware.  Modify it and/or enhance it as you see fit. 
  120.  
  121. Kevin Jessup 
  122. 9118 N. 85th St. 
  123. Milwaukee, WI 53224 
  124.